home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / wildcat / apdz21.zip / APP-DIZ.DOC next >
Text File  |  1992-11-21  |  13KB  |  360 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.    ██████████                                 █████████
  15.    ██      ██                                 ██       ██   ██
  16.    ██      ██                                 ██       ██
  17.    ██████████  ██████████  ██████████         ██       ██   ██   ███████
  18.    ██      ██  ██      ██  ██      ██  █████  ██       ██   ██        ▄
  19.    ██      ██  ██      ██  ██      ██         ██       ██   ██    ▄ ▀
  20.    ██      ██  ██████████  ██████████         █████████     ██   ███████
  21.                ██          ██
  22.                ██          ██
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.                         Apply-Diz by Dataware Software
  30.  
  31.                                  Version 2.1
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.                                
  44.                                 
  45.                                 Copyright (C) 1992
  46.                                         by
  47.                                     Tom Carroll
  48.  
  49.  
  50.                                 All rights reserved
  51.  
  52.  
  53.  
  54.                                  The Data Shop BBS
  55.                                 (509)582-9493 (HST)
  56.                                    Kennewick, WA
  57.                               FIDO address (1:347/10)
  58.  
  59.                               MAGIC FILE NAME: APPDIZ
  60.     ┌──────────────┐
  61.     │ INTRODUCTION │
  62.     └──────────────┘
  63.  
  64.     Apply-Diz is a utility designed to ease the burden of sysops trying to 
  65.     describe files, that either had their descriptions lost in the process of
  66.     a file transfer, or they are old enough that you just can't remember.  It
  67.     places the burden of describing files back onto the users and authors that
  68.     upload files without a description file such as FILE_ID.DIZ or DESC.SDI in
  69.     which Apply-Diz will make a FILE_ID.DIZ from the user supplied description
  70.     and compress it into the archive.  Apply-Diz can automatically detect
  71.     archives by signature, and extract or compress into the archive based on
  72.     this signature, no more relying on file suffixes.
  73.     
  74.     Apply-Diz has two purposes, one is to enhance the service that some of the
  75.     larger BBS's offer by insuring no matter what kind of file or archive
  76.     received on their system, either uploaded by users, downloaded from another
  77.     BBS, or copied to the system from monthly mailings, Apply-Diz will make
  78.     sure that two descriptions exist for the archive, one in the PCBoard(tm)
  79.     directory format, and the other in a FILE_ID.DIZ. (one of the two has to
  80.     exist, but neither one is overwritten if they both exist.)  This is a very
  81.     appealing feature that other sysops will appreciate if they subscribe to
  82.     your BBS and download your files for use on their systems.
  83.  
  84.     Two is the major reason Apply-Diz was invented.  I run a BBS, and I really
  85.     don't have all the time in the world to mess around with file descriptions,
  86.     and since I'm a programmer I tend to hold on to old archives, and then
  87.     forget what they are.  So I decided to cut half my workload and just write
  88.     a utility. (hmmm...  what am I saying?)
  89.     
  90.     You're probably asking your self "What is this guy babbling about?"  Well,
  91.     it's time to cut to the chase and show you how to operate it...
  92.  
  93.     ┌──────────────┐
  94.     │  DISCLAIMER  │
  95.     └──────────────┘
  96.  
  97.     This software is provided as is without warranty or guarantee either
  98.     expressed or implied.  The author will not be held responsible for ANY
  99.     damages that may result in the use of this program, including revenues
  100.     lost.  The Author will, however, be responsible for a full refund of the
  101.     purchasers registration cost should the software not be capable of
  102.     operating on the purchasers computer.
  103.  
  104.     Apply-Diz software and this document are Copyright (C) 1992 by Tom Carroll. 
  105.     All rights reserved.
  106.  
  107.     ┌──────────────┐
  108.     │   LICENSE    │
  109.     └──────────────┘
  110.  
  111.     This program is released as SHAREWARE.
  112.     
  113.     You are free to use this version of the program for a period of 30 days,
  114.     upon which, you must either register the software, or delete it from your
  115.     system with the exception of the original archive, which may be freely
  116.     distributed as outlined below.  Please refer to the ORDER.FRM included in
  117.     the distribution archive for registration information.
  118.  
  119.     Apply-Diz v2.1                                                       Page 2
  120.     No one may alter, modify, or reverse engineer Apply-Diz for any reason,
  121.     including but not limited to decompiling-compiling, patching, or
  122.     disassembling.
  123.  
  124.     You may freely distribute & copy this program for others subject to the
  125.     above restrictions and the following:
  126.  
  127.          ■ Apply-Diz is copied in unmodified form including this file. 
  128.          ■ There is no charge for copying except for the cost of disks.
  129.          ■ Apply-Diz is not included in another software package without
  130.            the express written permission of Tom Carroll
  131.  
  132.     You may operate Apply-Diz on one computer system at a time, one computer
  133.     system is defined as a single XT/AT/PC which operates solely by itself, or
  134.     multi-node BBS running the same BBS software and all nodes are connected
  135.     to a central file server.
  136.  
  137.     Should Apply-Diz need to be operated on more that one computer system, then
  138.     a site license will be negotiated.
  139.  
  140.     ┌──────────────┐
  141.     │   SUPPORT    │
  142.     └──────────────┘
  143.  
  144.     If you should find any problems with this program, or you have any requests
  145.     or recommendations, you may reach me on my BBS, or at the FIDO address
  146.     listed on the front cover.  I may also be reached in the FIDO PCBNET,
  147.     SaltAir, UN'I, ILink, Global-Net, or Source-Net sysop conferences.
  148.  
  149.     ┌──────────────┐
  150.     │    FILES     │
  151.     └──────────────┘
  152.  
  153.     Files included in this archive:
  154.  
  155.               APP-DIZ.DOC  - This manual
  156.               APP-DIZ.ERR  - Sample error file
  157.               APP-DIZ.EXE  - The Apply-Diz executable
  158.               APP-DIZ.HIS  - Apply-Diz History information file
  159.               APP-DIZ.LOG  - Sample log file
  160.               APP-DIZ.XLD  - Sample exclude file
  161.               FILE_ID.DIZ  - Description file for Apply-Diz
  162.               ORDER.FRM    - Registration form & ordering info
  163.               PROGRAMS.DWS - Other programs by Dataware Software
  164.  
  165.     I originally compressed this program as APDZnn.ARJ, but it may be
  166.     compressed with any other archive program you wish to use.
  167.  
  168.     The latest version will always be available on my BBS using the magic
  169.     filename of APPDIZ.
  170.  
  171.     Sometimes, there may be a need for debug code to be released.  This code is
  172.     used to track down specific problems which aren't normally encountered on
  173.     my system.  I have a 386/sx-25 w/4megs of RAM, and DOS 5.0, which should be
  174.     pretty standard and generic, but sometimes this doesn't present an
  175.     optimal testing environment, so please, if you're having problems, and
  176.     debug code is available, feel free to FREQ APDEBUG from me, or if you're
  177.     registered on my BBS call and download APPDIZ.ARJ from conference #1.
  178.     
  179.     Apply-Diz v2.1                                                       Page 3
  180.     If APPDIZ.ARJ isn't available, then you're the first person that has
  181.     found a problem, so please leave me your specifics so I may be able to
  182.     trouble shoot the problem(s).
  183.  
  184.     ┌──────────────┐
  185.     │  EXECUTION   │
  186.     └──────────────┘
  187.  
  188.     Apply-Diz is fully command line driven.
  189.  
  190.     The syntax for calling it is as follows:
  191.  
  192.     APP-DIZ <ARCHIVE> <PCBDIRLIST> { /Cx /INFO /NL /Rx /WKd: }
  193.  
  194.     <ARCHIVE> = Full path and filename(s) of the archive to be processed.
  195.  
  196.     <PCBDIRLIST> = Full PCBoard file directory listing to be processed.
  197.  
  198.     { Optional switches }
  199.  
  200.     /CF* = only checks for a FILE_ID.DIZ within the archive.
  201.  
  202.     /CP* = only checks for a description in the PCB DIR file.
  203.  
  204.     /INFO = Will add an archive information line to the PCBoard(tm) DIR list.
  205.             (i.e.  Files: nn Newest: mm-dd-yy Oldest: mm-dd-yy)
  206.  
  207.     /NL = Turns of the logging feature.  This is a good idea if you're going
  208.           to process a directory with many files.  It is on by default.
  209.  
  210.     /RF = Will overwrite the FILE_ID.DIZ file in the archive or create it if
  211.           it doesn't already exist.
  212.  
  213.     /RP = Will overwrite the PCBoard(tm) description with the FILE_ID.DIZ, or
  214.           DESC.SDI file within the archive.
  215.  
  216.     /WK = Allows Apply-Diz to use a work drive.  The drive must be specified
  217.           as DRIVE:.  (i.e.  /WKD: )
  218.  
  219.    * - The /Cx switch is only used for speed.  If a file is found to not have
  220.        either description Apply-Diz will default to normal mode for that file.
  221.    
  222.    +Wild cards "*" may be specified on the command line for the archive file
  223.     name.  (i.e.  C:\UPLOAD\*.ARJ or C:\UPLOAD\*.* is valid)
  224.  
  225.     You may at anytime during the processing of files press the <esc> key to
  226.     abort the process.  This really only has it's advantage in batch mode
  227.     operation since it will continue to process the present file it is working
  228.     on to ensure all open files are properly closed.
  229.  
  230.     ┌──────────────┐
  231.     │    NOTES     │
  232.     └──────────────┘
  233.  
  234.     At anytime, you may just type APP-DIZ without any command line arguments
  235.     and a help screen similar to this one will appear.
  236.     
  237.     
  238.     
  239.     Apply-Diz v2.1                                                       Page 4
  240.     You must specify the complete path for the archive name and the PCBoard
  241.     file directory listing.
  242.  
  243.    +In the registered version of App-Diz you may specify wild cards on the
  244.     command line for the processing of all files in one directory.
  245.  
  246.     If you are using an unregistered evaluation copy, insure you have command
  247.     line arguments correct if you run this utility in your nightly event
  248.     because there is a pause that requires input from the keyboard if they
  249.     are incorrect.
  250.  
  251.     Also, the unregistered version will append the last line of the PCBoard
  252.     file description with "Apply-Diz (UNREGISTERED EVALUATION COPY)".  This is
  253.     only appended to the PCBoard file listings, and not added to the
  254.     FILE_ID.DIZ.
  255.  
  256.     Any description lines in the PCBoard directory that you do not wish to 
  257.     be included in the FILE_ID.DIZ may be excluded by adding the unique
  258.     beginning string for that line in the exclude file.  See the sample
  259.     APP-DIZ.XLD for more details.  This file must be named APP-DIZ.XLD and
  260.     located within the same directory as the executable.
  261.  
  262.     Apply-Diz will make a log file, or append to an existing one while
  263.     processing files.  Please refer to the enclosed sample log file.  Apply-Diz
  264.     will report each action/non-action taken on a particular file, and why it
  265.     didn't take any action if that is the case.  This file is not controlled
  266.     for size, so make sure you keep an eye on it, or it could grow very large
  267.     in a short amount of time.
  268.  
  269.     If an error should occur while processing the files, Apply-Diz will make a
  270.     report to an APP-DIZ.ERR file which will be located in the same directory
  271.     as the executable.  This too is appended for later viewing.  Again this
  272.     file isn't monitored for size either.
  273.     
  274.     ┌──────────────┐
  275.     │ LIMITATIONS  │
  276.     └──────────────┘
  277.  
  278.     Apply-Diz is incapable of scanning self extracting files at this time.  It
  279.     will skip all files that have the suffix's of .EXE, .COM, .TXT, .GIF, .PCX,
  280.     .SDA, and .TIC.  If you have problems with any other files making App-Diz
  281.     abort the process, please let me know and I will add code to not allow
  282.     those types of files to be scanned.
  283.  
  284.     Apply-Diz is NOT Desqview aware, or capable of working with locked files.
  285.  
  286.     You must have the following archiver's for the defined archive types in
  287.     your path in order for App-Diz to operate correctly:
  288.  
  289.     ARC - ARC by System Enhancement Associates, Inc.
  290.     ARJ - ARJ by Robert K. Jung
  291.     LHA - LHARC by Haruyasu Yoshizaki
  292.     PAK - PAK by NoGate Consulting
  293.     ZIP - PKZip by PKWare, Inc.
  294.     ZOO - ZOO by Rahul Dhesi
  295.  
  296.     Apply-Diz must be executed from the current directory, or located somewhere
  297.     in your path statement.
  298.  
  299.     Apply-Diz v2.1                                                       Page 5
  300.     If a work drive is not specified Apply-Diz will create a work directory
  301.     off the root directory called APP-DIZ.  All logs and scratch files will
  302.     remain there until processing is completed or aborted.  If there is an
  303.     error during execution, all attempts are made to remove this directory
  304.     and clean all assosiated files.  The files creadted in the APP-DIZ
  305.     directory are:  TMP_ID.DIZ, DIZIT.TMP, FILE_ID.DIZ, and APP-DIZ.LOG.
  306.  
  307.     
  308.     
  309.     
  310.     
  311.     
  312.     
  313.     
  314.     
  315.     
  316.     
  317.     
  318.     
  319.     
  320.     
  321.     
  322.     
  323.     
  324.     
  325.     
  326.     
  327.     
  328.     
  329.     
  330.     
  331.     
  332.     
  333.     
  334.     
  335.     
  336.     
  337.     
  338.     
  339.     
  340.     
  341.     
  342.     
  343.     
  344.     
  345.     
  346.     
  347.     
  348.     
  349.     
  350.     
  351.     
  352.     
  353.     
  354.     
  355.     
  356.     
  357.     
  358.     
  359.     Apply-Diz v2.1                                                       Page 6
  360.